/*=============================================================================
Copyright (c) 2005 AUTOMATED LOGIC CORPORATION

This file is part of DominoTomcatSSOIntegration.
http://www.automatedlogic.com/domblog.nsf/dx/DominoTomcatSSOIntegration

DominoTomcatSSOIntegration is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

DominoTomcatSSOIntegration is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
http://www.gnu.org/licenses/gpl.html
=============================================================================*/

package com.automatedlogic.domino.sso.login;

/**
 * Used to store information about a login failure.  This object is stored in the user's session.
 * You can reference this object on the Login form to display an error message to the user.
 *
 * @author Brian Green, Automated Logic Corporation
 * @version 2.4.3, Feb 25 2005
 * @since JDK1.4.2_06
 */
public class DominoLoginFailure {

    private int dominoErrorID;
    private String dominoErrorText;


    public DominoLoginFailure(int dominoErrorID, String dominoErrorText) {
        this.dominoErrorID = dominoErrorID;
        this.dominoErrorText = dominoErrorText;
    }


    /**
     * @return The error id.  Use the "NotesError" class for information on this error.
     */
    public int getDominoErrorID() {
        return dominoErrorID;
    }

    /**
     * @param value New value for the error message id.
     */
    public void setDominoErrorID(int value) {
        dominoErrorID = value;
    }

    /**
     * @return The error message text.
     */
    public String getDominoErrorText() {
        if (dominoErrorText == null) {
            return "";
        } else {
            return dominoErrorText;
        }
    }

    /**
     * @param value New value for the error message text.
     */
    public void setDominoErrorText(String value) {
        dominoErrorText = value;
    }


}
